/**
	Copyright (c) 2009 Ozazo Pvt Ltd, INDIA

	Permission is hereby granted, free of charge, to any person or organization 
	obtaining a copy of this software and associated  documentation  files (the 
	"Software"), to deal in the Software without restriction, including without 
	limitation the rights to use, copy, modify, merge, publish, distribute, sub
	license, and/or sell copies of the Software, and to permit persons  to whom 
	the Software is furnished to do so, subject to the following conditions:
	
	The above copyright notice and  this permission notice shall be included in 
	all copies or substantial portions of the Software.
	
	THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING  BUT NOT  LIMITED  TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR  COPYRIGHT  HOLDERS  BE  LIABLE  FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY,  WHETHER  IN  AN  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
	FROM,  OUT  OF  OR  IN  CONNECTION  WITH  THE  SOFTWARE OR THE USE OR OTHER 
	DEALINGS IN THE SOFTWARE.
 */

package com.ozazo.wave.robots.fw.engines;

import java.util.List;
import java.util.Map;

import com.google.wave.api.Blip;

/**
 * @author Araf Karsh Hamid
 * @version 1.0
 * @seriel 20091121102030
 *
 */
public interface RobotEngineInterface {
	
	/**
	 * From the list of String Tokens - Create the URL
	 *
	 * @param List<Commands>
	 * @return List<Commands>
	 */	
	
	public List<Commands> processCommands(List<Commands> _list);
	
	/**
	 * This method illustrates how to replace the text in Blip without using TextView.replace(String) method.
	 * The above method looses all the styles and annotations of the TextView. This method uses the following functionality
	 * from the TextView object in the Google Wave.
	 * 
	 * 1. Uses Range and Annotations to insert the text in the right place.
	 * 2. Uses Annotations to create hyper links.
	 * 3. Uses replace with range parameter to edit specific substring of the text in the TextView.
	 * 
	 * @param Blip _blip
 	 * @param List<Commands> _dataMap
	 */
	
	public void processBlip(Blip _blip, List<Commands> _dataMap);	

	/**
	 * ---------------------------------------------------------------------------------------------------------
	 * [THIS METHOD IS FOR UNIT TESTING ONLY IN THE COMMAND LINE MODE]
	 * ---------------------------------------------------------------------------------------------------------
	 * Process the text. The Original message will be processed in this step.
	 * All the commands (/w) will be removed and the Tokens will be replace with
	 * Token + Result (a link or an image etc).
	 * 
	 * An updated new Text will be returned.
	 *
	 * @param String _text, List<Commands> _dataMap
	 * @return String text
	 */	

	public String processText(String _text, List<Commands> _dataMap);

}
